Use try...catch block with underscore.js template. #5984
Conversation
| // because of change of syntax in new versions. | ||
| // See: https://stackoverflow.com/a/25881231/8601393 | ||
| try { | ||
| // this is the old syntax |
There was a problem hiding this comment.
Let's be a little more specific in the comment here. Sphinx bundles Underscore.js v1.3.1 (and has for many years) and it looks like this syntax changed in Underscore v1.7.0 (not exactly how semver is supposed to work...). So Sphinx should always use the old syntax and almost never the new syntax. How was this throwing a syntax error exactly? Were people somehow bundling newer versions of Underscore?
There was a problem hiding this comment.
Ok, I figured it out. Sphinx has bundled Underscore.js v1.3.1 as I mentioned. However, doc builds before ~2019 used centrally located versions of jQuery and Underscore.js (due to readthedocs/readthedocs-sphinx-ext#52) as an optimization. That centrally located one uses Underscore.js v1.7.0. This optimization was removed precisely because it caused version mismatch issues like this! However, old doc builds still use this optimization.
Co-Authored-By: David Fischer <[email protected]>
|
Is it okay that we're assuming that underscore is loaded by the page? Is underscore a new implicit dependency with this change? The only case I can think of where a user does not have |
|
@agjohnson |
|
My point was I thought we needed to verify this, we've postulated about it a good deal. I inspected our commercial hosting, where themes are more heavily customized, and the only projects that did not have |
|
@ericholscher |
While it is possible, Sphinx search doesn't work without Underscore.js. So if they've customized so heavily that they've removed Underscore, they've likely also removed search. |
#5980 doesn't fixes #5978
Turns out that the problem was not of variable declaration.
But the error was due to syntax changes in underscore.js templating engine.
See: https://stackoverflow.com/a/25881231/8601393